CloudConvert

Click to copy

The module provides integration with CloudConvert


Settings

ParameterPresetDescription
API Key-Your Personal Access Token from CloudConvert
Use SandboxOff Enable Sandbox mode

Business processes

CloudConvert: Optimize Files

Input

  • input (array string) - the IDs of the input tasks;
  • profile (enum) - optimization profile for specific target needs. Defaults to web
  • input_format (enum) - the current format of the file, e.g. pdf. If not set, the extension of the input file is used as input format.

Output

  • task (model) - task created in CloudConvert.

CloudConvert: Merge files

Input

  • input (array string) - the IDs of the input tasks;
  • output_format (enum) - the target format. Must be PDF.

Output
 
task (model) - task created in CloudConvert.


CloudConvert: Wait task

Input

  • id (string) - the ID of the input task.

Output

  • task (model) - task created in CloudConvert.

CloudConvert: Create archive

Input

  • input (array string) - the IDs of the input tasks;
  • output_format (enum) - the target format.

Output

  • task (model) - task created in CloudConvert.

CloudConvert: Convert

Input

  • input (array string) - the IDs of the input tasks;
  • output_format (enum) - the target format;
  • filename (string) - name of the file in CloudConvert.

Output

  • task (model) - task created in CloudConvert.

CloudConvert: Upload

Input

  • File (file id) - file to upload.

Output

  • task (model) - task created in CloudConvert.

CloudConvert: Create thumbnail

Input

  • input (string) - the ID of the input task;
  • output_format (enum) - the target format;
  • weight (integer) - weight of thumbnail;
  • height (integer) - height of thumbnail
  • fit (enum) - Sets the mode of sizing the thumbnail. "Max" resizes the thumbnail to fit within the width and height, but will not increase the size of the image if it is smaller than width or height. "Crop" resizes the thumbnail to fill the width and height dimensions and crops any excess image data. "Scale" enforces the thumbnail width and height by scaling. Defaults to Max.

Output

  • task (model) - task created in CloudConvert.

CloudConvert: Show current user

Output

  • id (integer) - id of current user;
  • username (string) - username of current user;
  • email (email) - email of current user;
  • credits (integer) - credits of current user;
  • created_at (date) - user registration date.

CloudConvert: Download S3

Input

  • input (array string) - the IDs of the input tasks;
  • access_key_id (string) - the Amazon S3 access key id. It needs to have the s3:GetObject permission.
  • secret_access_key (string) - the Amazon S3 secret access key.
  • bucket (string) - the Amazon S3 bucket where to download the file.
  • region (string) - specify the Amazon S3 endpoint, e.g. us-west-2 or eu-west-1.
  • key (string) - S3 key of the input file (the filename in the bucket, including path).
     

CloudConvert: Upload S3

Input

  • file (string) - the ID of the input task;
  • access_key_id (string) - the Amazon S3 access key id. It needs to have the s3:PutObject permission. When using a different ACL from private, it needs to have the s3:PutObjectAcl permission.
  • secret_access_key (string) - the Amazon S3 secret access key.
  • bucket (string) - the Amazon S3 bucket where to store the file(s).
  • region (string) - specify the Amazon S3 endpoint, e.g. us-west-2 or eu-west-1.
  • key (string) - S3 key for storing the file (the filename in the bucket, including path). If there are multiple files to export, printf style placeholders are possible (e.g. myfile-%d.pdf produces the output files myfile-1.pdf, myfile-2.pdf and so on).

Output

  • task (model) - task created in CloudConvert.