CloudConvert

getting started with cloudconvert the cloudconvert modules allow you to monitor and manage jobs, tasks, and import\&export files in your cloudconvert account prerequisites a cloudconvert account in order to use cloudconvert with make, it is necessary to have a cloudconvert account if you do not have one, you can create a cloudconvert account at cloudconvert com/register https //cloudconvert com/register connecting cloudconvert to make to connect your cloudconvert account to make you need to obtain the api key from your cloudconvert account and insert it in the create a connection dialog in the make module log in to your cloudconvert account and open your dashboard open the authorization > api keys section click on the create new api key button enter the name for the api key, enable the scopes you want to use, and click the create button copy the provided token and store it in a safe place go to make and open the cloudconvert module's create a connection dialog enter the token you have created in step 5 and click the continue button to establish the connection common tasks convert a file converts a specified file to the selected file format connection cloudconvert docid\ njua2q fysjcuxfnuplza input file select whether you want to upload a file using make or provide the url the file will be uploaded from upload a file enter the source file by adding the file name and file data manually or by mapping the file from a previous module e g dropbox > get a file data enter or map the file data file name enter the file name including the file extension e g test txt import a file from url url enter the url of the file you want to convert headers define request headers (optional) useful, for example, when the specified url requires the authorization format select whether you want to specify the input format of the file you want to convert if not specified, the extension of the input file is used as the input format input format select the current format of the file output format select the target file format you want to convert the file to file name choose a filename (including extension) for the target output file conversion and engine specific options specify conversion and engine specific options to view available options, please visit their api documentation https //cloudconvert com/api/v2/convert#convert tasks and select the input format and output format download a file enable this option to include also file data in the module's output capture a website captures a specified website and saves it in pdf, jpg, or png format connection cloudconvert docid\ njua2q fysjcuxfnuplza url enter the url of the website you want to capture output format select whether you want to save the captured website in png, jpg, or pdf format file name enter a filename (including extension) for the target output file headers define request headers (optional) useful, for example, when the specified url requires the authorization conversion and engine specific options specify conversion and engine specific options to view available options, please visit their api documentation https //cloudconvert com/api/v2/capture website#capture website tasks and select the input format and output format download a file enable this option to include also file data in the module's output optimize a file optimizes and compresses a file currently supported formats are pdf, png and jpg connection cloudconvert docid\ njua2q fysjcuxfnuplza input file select whether you want to upload a file using make or provide the url the file will be uploaded from upload a file enter the source file by adding the file name and file data manually or by mapping the file from a previous module e g dropbox > get a file data enter or map the file data file name enter the file name including the file extension e g test txt import a file from url url enter the url of the file you want to optimize headers define request headers (optional) useful, for example, when the specified url requires the authorization optimization for select the optimization profile for specific target needs web optimization for the web ( default ) remove redundant and unnecessary data for the web down sample, clip, and intelligently compress images merge and subset fonts convert colors to rgb print optimization for print remove redundant and unnecessary data for printing down sample, clip, and intelligently compress images merge and subset fonts convert colors to cmyk archive optimization for archiving purposes remove redundant and unnecessary data for archiving intelligently compress images merge and subset fonts scanned images optimization for scanned images profile optimized for pdfs that mainly consist of raster images compress the images without significantly reducing the visual quality maximal size reduction optimization for maximal size reduction use the maximal possible compression might reduce the visual quality input format select the format of the input file you want to optimize file name enter the file name (including extension) for the target output file conversion and engine specific options specify conversion and engine specific options to view available options, please visit their api documentation https //cloudconvert com/api/v2/optimize#optimize tasks and select the output format download a file enable this option to include also file data in the module's output create an archive enables you to add one or multiple files to the zip, rar, 7z, tar, tar gz or tar bz2 archive connection cloudconvert docid\ njua2q fysjcuxfnuplza input files specify files you want to add to the archive upload a file enter the source file by adding the file name and file data manually or by mapping the file from a previous module e g dropbox > get a file data enter or map the file data file name enter the file name including the file extension e g test txt import a file from url url enter the url of the file you want to archive headers define request headers (optional) useful, for example, when the specified url requires the authorization output format select the target format of the archived file file name enter the file name (including extension) for the target output file conversion and engine specific options specify conversion and engine specific options to view available options, please visit their api documentation https //cloudconvert com/api/v2/archive#archive tasks and select the output format download a file enable this option to include also file data in the module's output merge files merges at least two files into one pdf if input files are not pdfs yet, they are automatically converted to pdf connection cloudconvert docid\ njua2q fysjcuxfnuplza input files specify files you want to add to the archive upload a file enter the source file by adding the file name and file data manually or by mapping the file from a previous module e g dropbox > get a file data enter or map the file data file name enter the file name including the file extension e g test txt import a file from url url enter the url of the file you want to archive headers define request headers (optional) useful, for example, when the specified url requires the authorization output format select the target format file name enter the file name (including extension) for the target output file conversion and engine specific options specify conversion and engine specific options to view available options, please visit their api documentation https //cloudconvert com/api/v2/merge#merge tasks and select the output format download a file enable this option to include also file data in the module's output jobs new job event triggers when the job or cloudconvert docid\ njua2q fysjcuxfnuplza is created , has finished , or has failed in your account the job created by the create a job (advanced) module consists of several tasks the new job event trigger is also triggered when an cloudconvert docid\ njua2q fysjcuxfnuplza is created, has finished, or has failed webhhook name enter the webhook name e g document conversion finished connection cloudconvert docid\ njua2q fysjcuxfnuplza event select whether the module is triggered when the job/task is created, has finished, or has failed create a job (advanced) this module performs a job (a job can be one or multiple tasks that are identified in the name field and linked between each other using the input field) for further processing of the finished job created with the create a job module, please use the docid\ njua2q fysjcuxfnuplza ( job finished ) module in another scenario connection cloudconvert docid\ njua2q fysjcuxfnuplza input files add the files you want to use within the job upload a file enter the source file by adding the file name and file data manually or by mapping the file from a previous module e g dropbox > get a file data enter or map the file data file name enter the file name including the file extension e g test txt import a file from url url enter the url of the file you want to process headers define request headers (optional) useful, for example, when the specified url requires the authorization tasks add tasks that will be performed within the job please find the descriptions of the operations' fields in the corresponding section convert a file https //www make com/en/help/apps/file and document management/cloudconvert html#convert a file 968217 capture a website https //www make com/en/help/apps/file and document management/cloudconvert html#capture a website optimize a file https //www make com/en/help/apps/file and document management/cloudconvert html#optimize a file merge files https //www make com/en/help/apps/file and document management/cloudconvert html#merge files create archives https //www make com/en/help/apps/file and document management/cloudconvert html#create an archive 968217 execute a command ( cloudconvert api documentation ) export a file to temporary url (specify the task name and input task name (e g conversion )) tag an arbitrary string to identify the job does not have any effect and can be used to associate the job with an id if working with the array aggregator (e g you have many files in different formats to convert), use the i don't know the input format option in the add a task dialog otherwise the error is returned linking tasks within the job ( name > input , name > input , ) list jobs retrieves all jobs that have been run in your account connection cloudconvert docid\ njua2q fysjcuxfnuplza status select the job status to filter returned jobs by limit set the number of returned jobs make will return during one execution cycle get a job retrieves job details connection cloudconvert docid\ njua2q fysjcuxfnuplza job id enter (map) the id of the job you want to retrieve details about delete a job deletes a job, including all tasks and data jobs are deleted automatically 24 hours after they have ended connection cloudconvert docid\ njua2q fysjcuxfnuplza job id enter (map) the id of the job you want to delete tasks get a task retrieves task details connection cloudconvert docid\ njua2q fysjcuxfnuplza task id enter (map) the id of the task you want to retrieve details about download a file retrieves file name and file data from the specified task connection cloudconvert docid\ njua2q fysjcuxfnuplza task id enter (map) the id of the task you want to download the file from list tasks retrieves all tasks in your account based on filter settings connection cloudconvert docid\ njua2q fysjcuxfnuplza status select the task status to filter returned tasks by job id enter (map) the job id to return only tasks within the specified job operation enter the operation type to return only tasks with the specified operation use the list possible operations module to retrieve operations limit set the number of returned tasks make will return during one execution cycle retry a task creates a new task, based on the settings (payload) of another task connection cloudconvert docid\ njua2q fysjcuxfnuplza task id enter (map) the id of the task you want to create a new task from cancel task cancels a task that has a status of waiting or processing connection cloudconvert docid\ njua2q fysjcuxfnuplza task id enter (map) the id of the task you want to cancel delete a task delete a task, including all data tasks are deleted automatically 24 hours after they have ended connection cloudconvert docid\ njua2q fysjcuxfnuplza task id enter (map) the id of the task you want to delete other get my info retrieves authenticated account details (including credits remaining conversion minutes) make an api call allows you to perform a custom api call connection cloudconvert docid\ njua2q fysjcuxfnuplza url enter a path relative to https //api cloudconvert com/ for example /v2/tasks for the list of available endpoints, refer to the cloudconvert api v2 documentation method select the http method you want to use get to retrieve information for an entry post to create a new entry put to update/replace an existing entry patch to make a partial entry update delete to delete an entry headers enter the desired request headers you don't have to add authorization headers; we already did that for you query string enter the request query string body enter the body content for your api call example of use list tasks the following api call returns all tasks from your cloudfront account url /v2/tasks method get matches of the search can be found in the module's output under bundle > body > data in our example, 6 tasks were returned troubleshooting error the authorization type is not supported or configured incorrectly, which can result in an error such as 400 , often caused by issues with the processing region to change your region in cloudconvert navigate to the cloudconvert dashboard https //cloudconvert com/dashboard in the left sidebar, click region in the processing region section, select one of the specific servers instead of auto click update for more information, refer to cloudconvert region endpoints https //cloudconvert com/api/v2#overview the following errors may occur when using the convert a file module error the output file size exceeds the limit allowed for your {{scenario singular lowercase}} please refer to file size limits in working with files docid\ oauioo6oujv0fyglzmrte error you have exceeded the maximum conversion time the free cloudconvert plan offers 25 conversion minutes daily if your usage exceeds the limit of the free plan, you may switch to a (prepaid) package or subscription https //cloudconvert org/pricing error failed to read frame size could not seek to 1508 �/output/jliadsa00137p0 mp3 invalid argument this error is thrown e g when converting files from mp3 to wav make sure that you have selected the correct region because it will find references to files but not only just the correct file runtimeerror maximum number of repeats exceeded locate the corresponding cloudconvert job in your cloudconvert dashboard https //cloudconvert com/dashboard/jobs 's list of jobs and check the job's duration the cloudconvert > convert a file module's timeout is set to 3 minutes if the job's duration exceeds 3 minutes (possibly due to a temporary overload of the cloudconvert service), the module throws the above mentioned error in this case consider one of these options enable the docid\ evar6qlowv4yyuneyv 00 option in the {{scenario singular lowercase}} settings to store the incomplete executions for later manual resolution optionally you may attach an error handling route to the cloudconvert module with the break directive to resolve the incomplete executions automatically introduction to error handling disable the download a file option in the cloudconvert > convert a file module in this case the module will not wait for the conversion result to obtain the conversion result, create a new {{scenario singular lowercase}} and use the cloudconvert > new job event trigger example converting a video from mov to mp4 format visit https //cloudconvert com/video converter https //cloudconvert com/video converter click on the "select file" button and choose your sample mov file click on the dropdown, next to "convert to" and choose mp4 click on the wrench icon configure the mp4 compression settings as you see fit click on the convert button once the conversion has been finished, click on the download button review the converted video repeat steps 1 to 8 until you have found the optimal conversion settings in step 5 visit https //cloudconvert com/api/v2/convert#convert tasks https //cloudconvert com/api/v2/convert#convert tasks choose 'mov' for the input format field choose 'mp4' for the output format field a list of all possible parameters like video codec , crf , etc will appear in make, insert the cloudconvert > convert a file module in your {{scenario singular lowercase}} open the module's settings configure the module as shown below make sure to include all the settings in the conversion and engine specific options field for each setting from step 5, locate the corresponding parameter from step 13 and its corresponding value