/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). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Task ID (UUID)."
}
},
"required": [
"PCID",
"id"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"engine": {
"type": "string",
"description": "Optional archiving engine override."
},
"filename": {
"type": "string",
"description": "Output filename."
},
"input": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of input task names to archive."
},
"output_format": {
"type": "string",
"description": "Archive format.",
"enum": [
"zip",
"rar",
"7z",
"tar",
"tar.gz",
"tar.bz2"
]
},
"timeout": {
"type": "integer",
"description": "Maximum task duration in seconds."
}
},
"required": [
"PCID",
"input",
"output_format"
]
}
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). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"css": {
"type": "string",
"description": "Custom CSS to inject before capturing."
},
"display_header_footer": {
"type": "boolean",
"description": "Display header/footer (PDF only)."
},
"engine": {
"type": "string",
"description": "Capture engine (e.g. 'chrome')."
},
"engine_version": {
"type": "string",
"description": "Optional engine version."
},
"filename": {
"type": "string",
"description": "Output filename."
},
"footer_template": {
"type": "string",
"description": "HTML template for the footer."
},
"header_template": {
"type": "string",
"description": "HTML template for the header."
},
"headers": {
"type": "object",
"description": "Custom HTTP headers for the request."
},
"javascript": {
"type": "string",
"description": "Custom JavaScript to run before capturing."
},
"margin_bottom": {
"type": "number",
"description": "Bottom margin in inches (PDF only)."
},
"margin_left": {
"type": "number",
"description": "Left margin in inches (PDF only)."
},
"margin_right": {
"type": "number",
"description": "Right margin in inches (PDF only)."
},
"margin_top": {
"type": "number",
"description": "Top margin in inches (PDF only)."
},
"output_format": {
"type": "string",
"description": "Output format: pdf, png, or jpg.",
"enum": [
"pdf",
"png",
"jpg"
]
},
"page_height": {
"type": "number",
"description": "Custom page height in inches (PDF only)."
},
"page_orientation": {
"type": "string",
"description": "Page orientation (PDF only).",
"enum": [
"portrait",
"landscape"
]
},
"page_width": {
"type": "number",
"description": "Custom page width in inches (PDF only)."
},
"pages": {
"type": "string",
"description": "Page range (PDF only), e.g. '1-3'."
},
"print_background": {
"type": "boolean",
"description": "Whether to print background graphics (PDF only)."
},
"timeout": {
"type": "integer",
"description": "Maximum task duration in seconds."
},
"url": {
"type": "string",
"description": "URL of the website to capture."
},
"wait_for_element": {
"type": "string",
"description": "CSS selector to wait for."
},
"wait_time": {
"type": "integer",
"description": "Additional wait time in milliseconds."
},
"wait_until": {
"type": "string",
"description": "When to consider the page loaded.",
"enum": [
"load",
"domcontentloaded",
"networkidle0",
"networkidle2"
]
},
"zoom": {
"type": "number",
"description": "Zoom factor (default 1.0)."
}
},
"required": [
"PCID",
"output_format",
"url"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"engine": {
"type": "string",
"description": "Optional conversion engine (e.g. 'office', 'libreoffice', 'imagemagick')."
},
"engine_version": {
"type": "string",
"description": "Optional engine version."
},
"filename": {
"type": "string",
"description": "Output filename (without extension)."
},
"input": {
"type": "array",
"items": {
"type": "string"
},
"description": "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": {
"type": "string",
"description": "Optional input file format override (e.g. 'pdf', 'docx')."
},
"output_format": {
"type": "string",
"description": "Target output format (e.g. 'pdf', 'png', 'docx', 'mp4')."
},
"timeout": {
"type": "integer",
"description": "Maximum task duration in seconds."
}
},
"required": [
"PCID",
"input",
"output_format"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"blob": {
"type": "string",
"description": "Destination blob path/name."
},
"container": {
"type": "string",
"description": "Blob container name."
},
"input": {
"type": "array",
"items": {
"type": "string"
},
"description": "Task name(s) whose output should be exported."
},
"sas_token": {
"type": "string",
"description": "Optional SAS token."
},
"storage_access_key": {
"type": "string",
"description": "Storage access key (or use sas_token)."
},
"storage_account": {
"type": "string",
"description": "Azure storage account name."
}
},
"required": [
"PCID",
"blob",
"container",
"input",
"storage_access_key",
"storage_account"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"access_token": {
"type": "string",
"description": "OAuth access token for Google Drive."
},
"file_name": {
"type": "string",
"description": "Optional destination filename."
},
"folder_id": {
"type": "string",
"description": "Optional destination folder ID."
},
"input": {
"type": "array",
"items": {
"type": "string"
},
"description": "Task name(s) whose output should be exported."
}
},
"required": [
"PCID",
"access_token",
"input"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"auth_url": {
"type": "string",
"description": "Keystone auth URL."
},
"container": {
"type": "string",
"description": "Swift container name."
},
"file": {
"type": "string",
"description": "Destination file path."
},
"input": {
"type": "array",
"items": {
"type": "string"
},
"description": "Task name(s) whose output should be exported."
},
"password": {
"type": "string",
"description": "OpenStack password."
},
"region": {
"type": "string",
"description": "OpenStack region."
},
"tenant_name": {
"type": "string",
"description": "Optional tenant/project name."
},
"username": {
"type": "string",
"description": "OpenStack username."
}
},
"required": [
"PCID",
"auth_url",
"container",
"file",
"input",
"password",
"region",
"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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"access_key_id": {
"type": "string",
"description": "AWS access key ID."
},
"acl": {
"type": "string",
"description": "S3 canned ACL (e.g. 'private', 'public-read')."
},
"bucket": {
"type": "string",
"description": "S3 bucket name."
},
"cache_control": {
"type": "string",
"description": "S3 Cache-Control header."
},
"endpoint": {
"type": "string",
"description": "Optional S3-compatible endpoint."
},
"input": {
"type": "array",
"items": {
"type": "string"
},
"description": "Task name(s) whose output should be exported."
},
"key": {
"type": "string",
"description": "Destination S3 key (path)."
},
"metadata": {
"type": "object",
"description": "S3 user metadata to attach."
},
"region": {
"type": "string",
"description": "AWS region."
},
"secret_access_key": {
"type": "string",
"description": "AWS secret access key."
},
"server_side_encryption": {
"type": "string",
"description": "S3 server-side encryption (e.g. 'AES256', 'aws:kms')."
},
"session_token": {
"type": "string",
"description": "Optional STS session token."
},
"tagging": {
"type": "object",
"description": "S3 object tags to attach."
}
},
"required": [
"PCID",
"access_key_id",
"bucket",
"input",
"key",
"secret_access_key"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"file": {
"type": "string",
"description": "Destination file path."
},
"host": {
"type": "string",
"description": "SFTP host."
},
"input": {
"type": "array",
"items": {
"type": "string"
},
"description": "Task name(s) whose output should be exported."
},
"password": {
"type": "string",
"description": "SFTP password (or use private_key)."
},
"port": {
"type": "integer",
"description": "SFTP port (default 22)."
},
"private_key": {
"type": "string",
"description": "Private key (PEM) (alternative to password)."
},
"username": {
"type": "string",
"description": "SFTP username."
}
},
"required": [
"PCID",
"file",
"host",
"input",
"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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"archive_multiple_files": {
"type": "boolean",
"description": "Pack multiple inputs into a single zip URL."
},
"inline": {
"type": "boolean",
"description": "Whether the URL serves the file inline (rather than as attachment)."
},
"input": {
"type": "array",
"items": {
"type": "string"
},
"description": "Task name(s) whose output should be exported."
}
},
"required": [
"PCID",
"input"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"blob": {
"type": "string",
"description": "Blob path/name."
},
"container": {
"type": "string",
"description": "Blob container name."
},
"filename": {
"type": "string",
"description": "Optional filename override."
},
"sas_token": {
"type": "string",
"description": "Optional SAS token (alternative to storage_access_key)."
},
"storage_access_key": {
"type": "string",
"description": "Storage access key (or use sas_token)."
},
"storage_account": {
"type": "string",
"description": "Azure storage account name."
}
},
"required": [
"PCID",
"blob",
"container",
"storage_access_key",
"storage_account"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"access_token": {
"type": "string",
"description": "OAuth access token for Google Drive."
},
"file_id": {
"type": "string",
"description": "Google Drive file ID."
},
"filename": {
"type": "string",
"description": "Optional filename override."
}
},
"required": [
"PCID",
"access_token",
"file_id"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"auth_url": {
"type": "string",
"description": "Keystone auth URL."
},
"container": {
"type": "string",
"description": "Swift container name."
},
"file": {
"type": "string",
"description": "File path within the container."
},
"filename": {
"type": "string",
"description": "Optional filename override."
},
"password": {
"type": "string",
"description": "OpenStack password."
},
"region": {
"type": "string",
"description": "OpenStack region."
},
"tenant_name": {
"type": "string",
"description": "Optional tenant/project name."
},
"username": {
"type": "string",
"description": "OpenStack username."
}
},
"required": [
"PCID",
"auth_url",
"container",
"file",
"password",
"region",
"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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"access_key_id": {
"type": "string",
"description": "AWS access key ID."
},
"bucket": {
"type": "string",
"description": "S3 bucket name."
},
"endpoint": {
"type": "string",
"description": "Optional custom S3-compatible endpoint."
},
"filename": {
"type": "string",
"description": "Optional filename override."
},
"key": {
"type": "string",
"description": "S3 object key (path)."
},
"region": {
"type": "string",
"description": "AWS region (e.g. 'us-east-1')."
},
"secret_access_key": {
"type": "string",
"description": "AWS secret access key."
},
"session_token": {
"type": "string",
"description": "Optional STS session token."
}
},
"required": [
"PCID",
"access_key_id",
"bucket",
"key",
"secret_access_key"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"file": {
"type": "string",
"description": "Remote file path."
},
"filename": {
"type": "string",
"description": "Optional filename override."
},
"host": {
"type": "string",
"description": "SFTP host."
},
"password": {
"type": "string",
"description": "SFTP password (or use private_key)."
},
"port": {
"type": "integer",
"description": "SFTP port (default 22)."
},
"private_key": {
"type": "string",
"description": "Private key (PEM) (alternative to password)."
},
"username": {
"type": "string",
"description": "SFTP username."
}
},
"required": [
"PCID",
"file",
"host",
"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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"filename": {
"type": "string",
"description": "Optional filename override."
},
"headers": {
"type": "object",
"description": "Optional HTTP headers for the source request."
},
"url": {
"type": "string",
"description": "Source URL of the file to import."
}
},
"required": [
"PCID",
"url"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tag": {
"type": "string",
"description": "Optional tag for the job (max 80 chars). Useful for filtering and identifying jobs later."
},
"tasks": {
"type": "object",
"description": "Object mapping task names to task definitions. Each value is a task object containing 'operation' plus operation-specific parameters."
},
"webhook_url": {
"type": "string",
"description": "Optional URL to receive a webhook notification when the job completes."
}
},
"required": [
"PCID",
"tasks"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"engine": {
"type": "string",
"description": "Optional engine override."
},
"filename": {
"type": "string",
"description": "Output filename."
},
"input": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of input task names to merge."
},
"output_format": {
"type": "string",
"description": "Output format (e.g. 'pdf')."
},
"timeout": {
"type": "integer",
"description": "Maximum task duration in seconds."
}
},
"required": [
"PCID",
"input",
"output_format"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"engine": {
"type": "string",
"description": "Metadata engine override."
},
"input": {
"type": "array",
"items": {
"type": "string"
},
"description": "Task name(s) of the input task."
},
"input_format": {
"type": "string",
"description": "Optional input format override."
},
"timeout": {
"type": "integer",
"description": "Maximum task duration in seconds."
}
},
"required": [
"PCID",
"input"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"engine": {
"type": "string",
"description": "Metadata engine override."
},
"filename": {
"type": "string",
"description": "Output filename."
},
"input": {
"type": "array",
"items": {
"type": "string"
},
"description": "Task name(s) of the input task."
},
"input_format": {
"type": "string",
"description": "Optional input format override."
},
"metadata": {
"type": "object",
"description": "Metadata key/value pairs to write."
},
"timeout": {
"type": "integer",
"description": "Maximum task duration in seconds."
}
},
"required": [
"PCID",
"input",
"metadata"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"engine": {
"type": "string",
"description": "Optimization engine (e.g. 'jpegoptim', 'pngquant')."
},
"engine_version": {
"type": "string",
"description": "Optional engine version."
},
"filename": {
"type": "string",
"description": "Output filename."
},
"input": {
"type": "array",
"items": {
"type": "string"
},
"description": "Task name(s) of the input task."
},
"input_format": {
"type": "string",
"description": "Optional input file format override."
},
"profile": {
"type": "string",
"description": "Optimization profile (e.g. 'web', 'print', 'archive', 'max')."
},
"timeout": {
"type": "integer",
"description": "Maximum task duration in seconds."
}
},
"required": [
"PCID",
"input"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"count": {
"type": "integer",
"description": "Number of thumbnails to generate."
},
"engine": {
"type": "string",
"description": "Optional engine override."
},
"filename": {
"type": "string",
"description": "Output filename."
},
"fit": {
"type": "string",
"description": "How to fit the thumbnail.",
"enum": [
"max",
"crop",
"scale"
]
},
"height": {
"type": "integer",
"description": "Thumbnail height in pixels."
},
"input": {
"type": "array",
"items": {
"type": "string"
},
"description": "Task name(s) of the input task."
},
"input_format": {
"type": "string",
"description": "Optional input format override."
},
"output_format": {
"type": "string",
"description": "Output image format (e.g. 'png', 'jpg', 'webp')."
},
"timeout": {
"type": "integer",
"description": "Maximum task duration in seconds."
},
"timestamp": {
"type": "string",
"description": "Timestamp for video thumbnails (e.g. '00:00:05.000')."
},
"width": {
"type": "integer",
"description": "Thumbnail width in pixels."
}
},
"required": [
"PCID",
"input",
"output_format"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"engine": {
"type": "string",
"description": "Optional engine override."
},
"filename": {
"type": "string",
"description": "Output filename."
},
"font_color": {
"type": "string",
"description": "Font color (hex)."
},
"font_name": {
"type": "string",
"description": "Font family name."
},
"font_size": {
"type": "integer",
"description": "Font size for text watermark."
},
"image": {
"type": "string",
"description": "Task name producing the watermark image."
},
"image_height": {
"type": "integer",
"description": "Image watermark height in pixels."
},
"image_width": {
"type": "integer",
"description": "Image watermark width in pixels."
},
"input": {
"type": "array",
"items": {
"type": "string"
},
"description": "Task name(s) of the input task."
},
"input_format": {
"type": "string",
"description": "Optional input format override."
},
"layer": {
"type": "string",
"description": "Watermark layer.",
"enum": [
"above",
"below"
]
},
"margin_horizontal": {
"type": "integer",
"description": "Horizontal margin in pixels."
},
"margin_vertical": {
"type": "integer",
"description": "Vertical margin in pixels."
},
"opacity": {
"type": "integer",
"description": "Watermark opacity (0-100)."
},
"output_format": {
"type": "string",
"description": "Output format (e.g. 'pdf')."
},
"position_horizontal": {
"type": "string",
"description": "Horizontal position.",
"enum": [
"left",
"center",
"right"
]
},
"position_vertical": {
"type": "string",
"description": "Vertical position.",
"enum": [
"top",
"center",
"bottom"
]
},
"rotation": {
"type": "integer",
"description": "Rotation in degrees."
},
"text": {
"type": "string",
"description": "Watermark text."
},
"timeout": {
"type": "integer",
"description": "Maximum task duration in seconds."
}
},
"required": [
"PCID",
"input"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"events": {
"type": "array",
"items": {
"type": "string",
"enum": [
"job.created",
"job.finished",
"job.failed"
]
},
"description": "Events to subscribe to."
},
"url": {
"type": "string",
"description": "Webhook target URL."
}
},
"required": [
"PCID",
"events",
"url"
]
}
cloudconvert_delete_job
Delete a job Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Job ID (UUID). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Job ID (UUID)."
}
},
"required": [
"PCID",
"id"
]
}
cloudconvert_delete_task
Delete a task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Task ID (UUID). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Task ID (UUID)."
}
},
"required": [
"PCID",
"id"
]
}
cloudconvert_delete_webhook
Delete a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Webhook ID. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Webhook ID."
}
},
"required": [
"PCID",
"id"
]
}
cloudconvert_get_current_user
Get current userShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
cloudconvert_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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Job ID (UUID)."
},
"include": {
"type": "string",
"description": "Comma-separated relations to include: tasks."
}
},
"required": [
"PCID",
"id"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Task ID (UUID)."
},
"include": {
"type": "string",
"description": "Comma-separated relations to include: job, payload."
}
},
"required": [
"PCID",
"id"
]
}
cloudconvert_get_webhook
Get a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Webhook ID. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Webhook ID."
}
},
"required": [
"PCID",
"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). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"filter[status]": {
"type": "string",
"description": "Filter by job status: waiting, processing, finished, error.",
"enum": [
"waiting",
"processing",
"finished",
"error"
]
},
"filter[tag]": {
"type": "string",
"description": "Filter by job tag."
},
"include": {
"type": "string",
"description": "Comma-separated list of relations to include: tasks."
},
"per_page": {
"type": "integer",
"description": "Results per page (max 100)."
},
"page": {
"type": "integer",
"description": "Page number (1-indexed)."
}
},
"required": [
"PCID"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"filter[operation]": {
"type": "string",
"description": "Filter by operation type (e.g. 'convert', 'optimize')."
},
"filter[input_format]": {
"type": "string",
"description": "Filter by input file format (e.g. 'pdf')."
},
"filter[output_format]": {
"type": "string",
"description": "Filter by output file format (e.g. 'docx')."
},
"filter[engine]": {
"type": "string",
"description": "Filter by engine."
},
"filter[engine_version]": {
"type": "string",
"description": "Filter by engine version."
},
"include": {
"type": "string",
"description": "Comma-separated relations to include."
}
},
"required": [
"PCID"
]
}
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). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"filter[job_id]": {
"type": "string",
"description": "Filter tasks by job ID."
},
"filter[status]": {
"type": "string",
"description": "Filter by task status: waiting, processing, finished, error.",
"enum": [
"waiting",
"processing",
"finished",
"error"
]
},
"filter[operation]": {
"type": "string",
"description": "Filter by operation name (e.g. convert, import/url, export/url)."
},
"include": {
"type": "string",
"description": "Comma-separated relations to include: job, payload."
},
"per_page": {
"type": "integer",
"description": "Results per page (max 100)."
},
"page": {
"type": "integer",
"description": "Page number (1-indexed)."
}
},
"required": [
"PCID"
]
}
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). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"per_page": {
"type": "integer",
"description": "Results per page (max 100)."
},
"page": {
"type": "integer",
"description": "Page number (1-indexed)."
}
},
"required": [
"PCID"
]
}
cloudconvert_retry_task
Retry a task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Task ID (UUID) to retry. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Task ID (UUID) to retry."
}
},
"required": [
"PCID",
"id"
]
}

