CloudConvert icon

CloudConvert

Use CloudConvert to convert files, create thumbnails, merge files, add watermarks and more!

Overview

The node integrates with CloudConvert, a cloud-based file conversion and processing service. It allows users to perform various file operations such as converting files between formats, creating thumbnails, merging multiple files into one, archiving files, optimizing/compressing files, adding watermarks, extracting metadata, and capturing website screenshots or PDFs.

Specifically, the Optimize File operation compresses or optimizes a file to reduce its size without significantly compromising quality. This is useful for reducing storage costs, speeding up file transfers, or preparing files for web use.

Practical examples:

  • Compressing large images or PDFs before uploading them to a website.
  • Optimizing video or audio files to reduce bandwidth usage.
  • Reducing the size of documents for email attachments.

Properties

Name Meaning
Authentication Method used to authenticate with CloudConvert API. Options: "OAuth2 (Recommended)" or "API Key".
Binary Input Data Whether the input file should be taken from a binary field in the incoming data (true) or from text content provided directly (false).
Input Binary Property (Shown if Binary Input Data is true) The name of the binary property that contains the file data to be optimized. Default is "data".
Input File Content (Shown if Binary Input Data is false) The raw text content of the file to upload and optimize.
Input Filename (Shown if Binary Input Data is false) The filename including extension of the input file.
Additional Options A JSON dictionary of extra options to customize the optimization task. These options are passed directly to CloudConvert and can control advanced features of the optimization process.

Output

The node outputs the result of the optimization operation in the json output field. This typically includes metadata about the processed file and a reference or URL to the optimized file.

If the input was binary, the node will also output the optimized file as binary data under the specified binary property, allowing further workflow steps to access the compressed file directly.

Dependencies

  • Requires an active CloudConvert account.
  • Requires either OAuth2 authentication or an API key credential configured in n8n to access the CloudConvert API.
  • Internet connectivity to communicate with CloudConvert's cloud service.

Troubleshooting

  • Invalid operation error: If the operation parameter is set incorrectly or unsupported, the node throws an error indicating an invalid operation.
  • Authentication failures: Ensure that the API key or OAuth2 credentials are valid and have sufficient permissions.
  • File not found or empty input: When using binary input, verify that the specified binary property exists and contains data. For text input, ensure the content and filename are provided.
  • CloudConvert API errors: Errors returned by CloudConvert (e.g., unsupported file format, quota exceeded) will be propagated. Check the error message for details and adjust inputs or account limits accordingly.
  • JSON syntax errors in Additional Options: If providing custom JSON options, ensure the JSON is well-formed to avoid parsing errors.

Links and References

Discussion