Skip to main content
CloudConvert logo
  • Category: file management & storage
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 9
  • Triggers: 0
  • Slug: CLOUDCONVERT
  • Version: 20261101_00

Tools

Slug: CLOUDCONVERT_CREATE_EXPORT_GOOGLE_CLOUD_STORAGE_TASKTool to create a task to export files to a Google Cloud Storage bucket. Use after conversion when you need to store results directly into GCS. Ensure service account credentials have the proper permissions.

Input Parameters

string
Filename/path for the exported file in the bucket.
string
required
The ID of the task to export. Multiple task IDs can be provided as a list.
string
required
The Google Cloud Storage bucket name.
string
required
The Google Cloud Project ID (api-project-...).
string
Prefix for exported files in the bucket when exporting multiple files.
string
required
The private key of the service account (PEM-encoded).
string
required
Service account client email (e.g., my-sa@api-project-123456.iam.gserviceaccount.com).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCONVERT_CREATE_EXPORT_S3_TASKTool to create a task to export files to an Amazon S3 bucket. Use after conversion when you need to store results directly into S3. Ensure AWS credentials have s3:PutObject (and PutObjectAcl if using non-default ACL) permissions.

Input Parameters

string ("private" | "public-read" | "public-read-write" | "authenticated-read" | "bucket-owner-read" | "bucket-owner-full-control")
S3 ACL for stored objects. Defaults to ‘private’.
string
S3 object key (filename and path) for storing the file. Supports printf-style placeholders for multiple files, e.g., ‘file-%d.pdf’.
string
required
The ID of the task to export, or a list of task IDs.
string
required
The Amazon S3 bucket where to store the file(s).
string
required
S3 region identifier (e.g., ‘us-west-2’ or ‘eu-west-1’).
object
S3 object tags as key–value pairs.
string
Custom S3 API endpoint URL. Overrides default built from region. Use for S3-compatible services.
object
Additional S3 metadata as key–value pairs (e.g., ‘x-amz-meta-*’).
string
Prefix to prepend to the S3 object key when exporting multiple files.
string
Value for the ‘Content-Type’ header. Auto-detected if omitted.
string
required
AWS access key ID with s3:PutObject permission.
string
Value for the ‘Cache-Control’ header (e.g., ‘max-age=172800’).
string
AWS session token for temporary (STS) credentials.
string
required
AWS secret access key.
string
Value for the ‘Content-Disposition’ header (e.g., ‘attachment’ or ‘inline’).
string ("AES256" | "aws:kms")
Server-side encryption algorithm to use (AES256 or aws:kms).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCONVERT_CREATE_WEBHOOKCreates a new webhook to receive CloudConvert event notifications. Use this when you need to be notified about job status changes (created, finished, or failed) via HTTP POST requests to your server.

Input Parameters

string
required
The target URL where CloudConvert will send webhook notifications. Must be a publicly accessible HTTPS URL.
string
required
Event type to subscribe to. Valid values: ‘job.created’ (when a job is created), ‘job.finished’ (when a job completes successfully), ‘job.failed’ (when a job fails).
object
Optional custom payload object to include in each webhook notification. Useful for passing context like user IDs or request identifiers.
string
Optional secret used to sign webhook payloads via HMAC-SHA256. Use this to verify that webhook requests originate from CloudConvert.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCONVERT_DELETE_WEBHOOKPermanently delete a webhook by its ID. Use this when you no longer need to receive event notifications for a specific webhook. The webhook ID can be obtained from the create_webhook or list_webhooks actions.

Input Parameters

string
required
The numeric ID of the webhook to delete. Obtain this from the create_webhook or list_webhooks actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCONVERT_LIST_OPERATIONSTool to list all possible CloudConvert operations with their available options and engine details. Use when you need to discover what operations are available, check operation requirements, or filter by input/output formats before creating tasks.

Input Parameters

string
Comma-separated list of additional data to include. Options: ‘options’ (operation parameters), ‘engine_versions’ (available engine versions).
string
Filter operations by input format. Only returns operations that accept this format as input.
string
Filter operations by output format. Only returns operations that produce this format as output.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCONVERT_LIST_SUPPORTED_FORMATSTool to list all supported conversion formats, engines, and options. Use when you need to discover available conversions before creating tasks.

Input Parameters

array
Include additional data: options and/or engine_versions.
boolean
Set to true to include alternative conversion types.
string
Filter to include only conversions with this engine name.
string
Filter to include only conversions with this input format.
string
Filter to include only conversions with this output format.
string
Filter to include only conversions with this engine version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCONVERT_LIST_TASKSList a page of CloudConvert tasks, with filters including status and job ID. Use the results to monitor progress, inspect available payloads and output URLs, or debug errors.

Input Parameters

integer
Page number to retrieve (1-indexed). Use with per_page for pagination through large result sets.
string
Filter tasks by job ID. Only returns tasks belonging to the specified job.
string ("waiting" | "processing" | "finished" | "error")
Filter tasks by status: ‘waiting’ (queued), ‘processing’ (in progress), ‘finished’ (completed successfully), or ‘error’ (failed).
string
Comma-separated list of additional data to include in response. Options: ‘retries’ (retry tasks), ‘depends_on_tasks’ (task dependencies), ‘payload’ (submitted configuration).
string
Order results by a column with optional direction. Format: ‘column_name [asc|desc]’. Common columns: ‘created_at’, ‘ended_at’.
integer
Number of tasks per page. Default is 100, maximum is 500.
string
Filter tasks by operation type, e.g., ‘convert’, ‘import/url’, ‘import/s3’, ‘export/url’, ‘export/s3’.
string
Filter tasks by creation datetime in ISO 8601 format. Supports comparison operators like [gte] for date ranges.
string
Filter tasks by completion datetime in ISO 8601 format. Only applies to finished or error status tasks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCONVERT_LIST_WEBHOOKSList a page of existing webhooks, optionally filtered by URL, for inspection or management.

Input Parameters

integer
Page number to return (default: 1)
integer
Number of webhooks per page (default: 100)
string
Filter results to webhooks with this URL

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCONVERT_SHOW_USERRetrieves the current authenticated user’s CloudConvert account information. Returns the user’s ID, username, email, remaining conversion credits, and account creation date. Requires the ‘user.read’ scope. Useful for verifying authentication and checking available credits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not